<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Reranker Framework (ReFr): reranker::MultiFileCandidateSetIterator Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Reranker Framework (ReFr)
   
   </div>
   <div id="projectbrief">Reranking framework for structure prediction and discriminative language modeling</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacereranker.html">reranker</a>      </li>
      <li class="navelem"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html">MultiFileCandidateSetIterator</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">reranker::MultiFileCandidateSetIterator Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="reranker::MultiFileCandidateSetIterator" --><!-- doxytag: inherits="reranker::CandidateSetIterator" -->
<p>An implementation of the <a class="el" href="classreranker_1_1_candidate_set_iterator.html">CandidateSetIterator</a> interface that iterates over <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances that have been serialized to <code>CandidateSetMessage</code> protocol buffer messages in multiple files.  
 <a href="classreranker_1_1_multi_file_candidate_set_iterator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for reranker::MultiFileCandidateSetIterator:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classreranker_1_1_multi_file_candidate_set_iterator.png" usemap="#reranker::MultiFileCandidateSetIterator_map" alt=""/>
  <map id="reranker::MultiFileCandidateSetIterator_map" name="reranker::MultiFileCandidateSetIterator_map">
<area href="classreranker_1_1_candidate_set_iterator.html" title="An interface specifying iteration over CandidateSet instances, using Java-style semantics (sorry..." alt="reranker::CandidateSetIterator" shape="rect" coords="0,0,230,24"/>
</map>
 </div></div>

<p><a href="classreranker_1_1_multi_file_candidate_set_iterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a3e6731a7c90dc2fa62035dc135086f59">MultiFileCandidateSetIterator</a> (vector&lt; string &gt; files, const <a class="el" href="classreranker_1_1_executive_feature_extractor.html">ExecutiveFeatureExtractor</a> *efe, int max_examples, int max_candidates, int reporting_interval, int verbosity, bool compressed, bool use_base64)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new instance that iterates over the <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances serialized in the specified sequence of files.  <a href="#a3e6731a7c90dc2fa62035dc135086f59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a5c82d1ada54b5febd4de83b61e34b9b4">HasNext</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a6e2aafde5423945b3149ea91f3314b3f">Next</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#ab7aa3c23a52a31142f90368dc4d24d42">curr_file</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#aaeac4c678b4e1611f09a5b349f41acd9">Reset</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets this multi-file candidate set iterator so that the next <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> retrieved will be the first serialized instance in the first of the sequence of files with which this <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html">MultiFileCandidateSetIterator</a> was constructed.  <a href="#aaeac4c678b4e1611f09a5b349f41acd9"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An implementation of the <a class="el" href="classreranker_1_1_candidate_set_iterator.html">CandidateSetIterator</a> interface that iterates over <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances that have been serialized to <code>CandidateSetMessage</code> protocol buffer messages in multiple files. </p>
<p>The sequence of files containing serialized <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances are specified at construction time. </p>

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00111">111</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3e6731a7c90dc2fa62035dc135086f59"></a><!-- doxytag: member="reranker::MultiFileCandidateSetIterator::MultiFileCandidateSetIterator" ref="a3e6731a7c90dc2fa62035dc135086f59" args="(vector&lt; string &gt; files, const ExecutiveFeatureExtractor *efe, int max_examples, int max_candidates, int reporting_interval, int verbosity, bool compressed, bool use_base64)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a3e6731a7c90dc2fa62035dc135086f59">reranker::MultiFileCandidateSetIterator::MultiFileCandidateSetIterator</a> </td>
          <td>(</td>
          <td class="paramtype">vector&lt; string &gt;&#160;</td>
          <td class="paramname"><em>files</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classreranker_1_1_executive_feature_extractor.html">ExecutiveFeatureExtractor</a> *&#160;</td>
          <td class="paramname"><em>efe</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>max_examples</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>max_candidates</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>reporting_interval</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>verbosity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>compressed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>use_base64</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructs a new instance that iterates over the <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances serialized in the specified sequence of files. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">files</td><td>the sequence of files containing serialized <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances </td></tr>
    <tr><td class="paramname">efe</td><td>a pointer to an <a class="el" href="classreranker_1_1_executive_feature_extractor.html">ExecutiveFeatureExtractor</a> instance; if non-<code>NULL</code>, this iterator will invoke the <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ae825fd69b80d636cb12d95e39a1c3e20">ExecutiveFeatureExtractor::Extract</a> on each <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instance returned by this iterator&rsquo;s <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a6e2aafde5423945b3149ea91f3314b3f">Next</a> method </td></tr>
    <tr><td class="paramname">max_examples</td><td>the maximum number of examples to be read from each file specified by the <code>files</code> parameter (as per the first parameter of the <a class="el" href="classreranker_1_1_candidate_set_reader.html#a44f8ba2b5bbd12134bd7d42375ea390e">CandidateSetReader::CandidateSetReader(int,int,long)</a> constructor) </td></tr>
    <tr><td class="paramname">max_candidates</td><td>the maximum number of candidates to be read for each de-serialized <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instance (as per the second parameter of the <a class="el" href="classreranker_1_1_candidate_set_reader.html#a44f8ba2b5bbd12134bd7d42375ea390e">CandidateSetReader::CandidateSetReader(int,int,long)</a> constructor) </td></tr>
    <tr><td class="paramname">reporting_interval</td><td>the number of <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances read after which a message will be issued to <code>cerr</code> </td></tr>
    <tr><td class="paramname">verbosity</td><td>the verbosity level of this instance and its underlying objects (see <a class="el" href="classreranker_1_1_candidate_set_reader.html#a46df40e5ad98bdee0bb0a552512349d5">CandidateSetReader::set_verbosity</a>) </td></tr>
    <tr><td class="paramname">compressed</td><td>whether the files containing serialized <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances are compressed </td></tr>
    <tr><td class="paramname">use_base64</td><td>whether the files containing serialized <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances use base64 encoding </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00150">150</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab7aa3c23a52a31142f90368dc4d24d42"></a><!-- doxytag: member="reranker::MultiFileCandidateSetIterator::curr_file" ref="ab7aa3c23a52a31142f90368dc4d24d42" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const string <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#ab7aa3c23a52a31142f90368dc4d24d42">reranker::MultiFileCandidateSetIterator::curr_file</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00184">184</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>

</div>
</div>
<a class="anchor" id="a5c82d1ada54b5febd4de83b61e34b9b4"></a><!-- doxytag: member="reranker::MultiFileCandidateSetIterator::HasNext" ref="a5c82d1ada54b5febd4de83b61e34b9b4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a5c82d1ada54b5febd4de83b61e34b9b4">reranker::MultiFileCandidateSetIterator::HasNext</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns whether this iterator contains another <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a>. </p>
 
<p>Implements <a class="el" href="classreranker_1_1_candidate_set_iterator.html#a82457e09d587f9e83ef3db066e8ac485">reranker::CandidateSetIterator</a>.</p>

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00172">172</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>

</div>
</div>
<a class="anchor" id="a6e2aafde5423945b3149ea91f3314b3f"></a><!-- doxytag: member="reranker::MultiFileCandidateSetIterator::Next" ref="a6e2aafde5423945b3149ea91f3314b3f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a>&amp; <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#a6e2aafde5423945b3149ea91f3314b3f">reranker::MultiFileCandidateSetIterator::Next</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the next <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a>. </p>
 
<p>Implements <a class="el" href="classreranker_1_1_candidate_set_iterator.html#aa318e5cebc531e88bce5f6d9077f41ee">reranker::CandidateSetIterator</a>.</p>

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00177">177</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>

</div>
</div>
<a class="anchor" id="aaeac4c678b4e1611f09a5b349f41acd9"></a><!-- doxytag: member="reranker::MultiFileCandidateSetIterator::Reset" ref="aaeac4c678b4e1611f09a5b349f41acd9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html#aaeac4c678b4e1611f09a5b349f41acd9">reranker::MultiFileCandidateSetIterator::Reset</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Resets this multi-file candidate set iterator so that the next <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> retrieved will be the first serialized instance in the first of the sequence of files with which this <a class="el" href="classreranker_1_1_multi_file_candidate_set_iterator.html">MultiFileCandidateSetIterator</a> was constructed. </p>

<p>Implements <a class="el" href="classreranker_1_1_candidate_set_iterator.html#a10751b02e9aa29e8f2a1c76085b661ac">reranker::CandidateSetIterator</a>.</p>

<p>Definition at line <a class="el" href="candidate-set-iterator_8_h_source.html#l00192">192</a> of file <a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="candidate-set-iterator_8_h_source.html">candidate-set-iterator.H</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Apr 9 2013 11:56:30 for Reranker Framework (ReFr) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
